[Woo POS][Local Catalog] Catalog full sync required #14678

samiuelson · 2025-10-02T11:01:19Z

Description

The goal of PR is to improve the reliability of the full sync of POS local catalog.
The full sync is scheduled to be performed every 24h, at night. However, in case the device was turned off at night, the sync may not succeed. To handle such case, this PR adds:

Keeping track of the last full sync timestamp
Checking if the last full sync is overdue (7 days)
Scheduling one-time, instant full sync in case the full sync was never done before, or data is missing (WooPosProductEntity is empty)

⚠️ Do not merge until the base branch is trunk.

Steps to reproduce

The full sync should be performed in a blocking way before allowing access to the POS for the first time (or in case product data is missing)

Testing information

Wipe the PosProductsEntity table and then verify that the full sync occurs when entering POS.

The tests that have been performed

Above.

Images/gif

Screen_recording_20251007_181723.mp4

I have considered if this change warrants release notes and have added them to RELEASE-NOTES.txt if necessary. Use the "[Internal]" label for non-user-facing changes.

wpmobilebot · 2025-10-02T11:06:17Z

📲 You can test the changes from this Pull Request in WooCommerce-Wear Android by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce-Wear Android
	Platform	⌚️ Wear OS
	Flavor	Jalapeno
	Build Type	Debug
	Commit	`849a70f`
	Direct Download	`woocommerce-wear-prototype-build-pr14678-849a70f.apk`

wpmobilebot · 2025-10-02T11:18:47Z

📲 You can test the changes from this Pull Request in WooCommerce Android by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce Android
	Platform	📱 Mobile
	Flavor	Jalapeno
	Build Type	Debug
	Commit	`849a70f`
	Direct Download	`woocommerce-prototype-build-pr14678-849a70f.apk`

codecov-commenter · 2025-10-02T12:15:26Z

Codecov Report

❌ Patch coverage is 36.87943% with 178 lines in your changes missing coverage. Please review.
✅ Project coverage is 38.04%. Comparing base (ef133c4) to head (849a70f).
⚠️ Report is 60 commits behind head on trunk.

Files with missing lines	Patch %	Lines
...oopos/home/items/WooPosCatalogSyncOverdueBanner.kt	0.00%	64 Missing ⚠️
...ocalcatalog/WooPosPerformInstantCatalogFullSync.kt	44.77%	31 Missing and 6 partials ⚠️
...atalog/WooPosPerformLocalCatalogInitialFullSync.kt	3.84%	25 Missing ⚠️
.../android/ui/woopos/splash/WooPosSplashViewModel.kt	34.78%	13 Missing and 2 partials ⚠️
...os/util/datastore/WooPosSyncTimestampRepository.kt	0.00%	13 Missing ⚠️
...os/localcatalog/WooPosLocalCatalogSyncScheduler.kt	0.00%	8 Missing ⚠️
...droid/ui/woopos/home/items/WooPosItemsViewModel.kt	73.33%	3 Missing and 1 partial ⚠️
.../store/pos/localcatalog/WooPosLocalCatalogStore.kt	0.00%	4 Missing ⚠️
...oopos/util/datastore/WooPosSyncTimestampManager.kt	0.00%	3 Missing ⚠️
...erce/android/ui/woopos/splash/WooPosSplashState.kt	0.00%	2 Missing ⚠️
... and 3 more

Additional details and impacted files

@@             Coverage Diff              @@
##              trunk   #14678      +/-   ##
============================================
- Coverage     38.05%   38.04%   -0.01%     
- Complexity     9997    10020      +23     
============================================
  Files          2120     2124       +4     
  Lines        119445   119716     +271     
  Branches      16254    16302      +48     
============================================
+ Hits          45449    45545      +96     
- Misses        69411    69574     +163     
- Partials       4585     4597      +12

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…n-pos-splash' into woomob-1412-woo-poslocal-catalog-full-sync-overdue-handling

dangermattic · 2025-10-03T07:22:56Z

	1 Warning
⚠️	This PR is larger than 300 lines of changes. Please consider splitting it into smaller PRs for easier and faster reviews.

Generated by 🚫 Danger

samiuelson · 2025-10-16T13:07:06Z

When we are doing an initial full sync, the blocking screen should be full screen (part of splash screen):

I noticed that currently during the full sync, the blocking layer is semi-transparent, so I can see products already loaded below the loading state:

That was fixed 👍

I can see loading skeletons during an incremental sync - the incremental sync shouldn't be visible to the user as it goes against the speed we are trying to achieve.

Not sure if it's an issue, but I can see the loading skeletons for 0.5seconds even when I turn off the feature flag even though we load the items during the splashscreen.

Let me improve 3. and 4. in a separate PR, as this one grew too big—sorry for that, BTW! I created task for this: WOOMOB-1525

The POS is not accessible when there is no internet connection even though I have data in the database + I can see the data behind the error:

Good catch. This was fixed 👍

Thank you for the review, @malinajirka! I addressed your comments. Also, sorry for the long PR I failed to keep it within a limit.

Copilot

Pull Request Overview

Copilot reviewed 22 out of 22 changed files in this pull request and generated 5 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

...rc/main/kotlin/com/woocommerce/android/ui/woopos/localcatalog/WooPosFullSyncStatusChecker.kt

...kotlin/com/woocommerce/android/ui/woopos/localcatalog/WooPosPerformInstantCatalogFullSync.kt

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/splash/WooPosSplashScreen.kt

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/home/items/WooPosItemsScreen.kt

Co-authored-by: Copilot <[email protected]>

wpmobilebot · 2025-10-17T12:37:03Z

Version 23.5 has now entered code-freeze, so the milestone of this PR has been updated to 23.6.

malinajirka

Thanks @samiuelson for iterating on the PR! I've reviewed the code and it all looks good to me. However, I've encountered a couple issues when testing the PR. I'd consider merging it as is and fixing the bugs in a separate PR, wdyt?

Infinite splash screen

Downgrade your site to WooCommerce 10.2 or older
Clean apps data
Login
Enter POS
Notice catalog is syncing -> notice /variations requests fail since the endpoint isn't available in v10.2 => the logs mention Worker result RETRY which isn't properly handled (it goes again into ENQUEUED state on Retry).

POS Opened with empty catalog

Clean apps data
Login
Turn off wifi/data
Open POS
Notice expected error
Tap on retry
Turn on wifi/data
Tap on retry
Notice you are allowed to enter POS before the initial sync completes.

My.Movie.mp4

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/splash/WooPosSplashViewModel.kt

malinajirka · 2025-10-18T17:04:27Z

...-plugin/src/main/kotlin/org/wordpress/android/fluxc/persistence/dao/pos/WooPosProductsDao.kt

    abstract suspend fun getProduct(localSiteId: LocalId, remoteId: RemoteId): WooPosProductEntity?

+    @Query("SELECT COUNT(*) FROM PosProductEntity WHERE localSiteId = :localSiteId")
+    abstract suspend fun getProductCount(localSiteId: LocalId): Int


📓 I think this is fine for the current use case, but we need to be careful, since getProductCount returns count of all products including those which are not supported by the POS (hidden in the POS).

malinajirka · 2025-10-18T17:20:19Z

...rc/main/kotlin/com/woocommerce/android/ui/woopos/localcatalog/WooPosFullSyncStatusChecker.kt

+            wooPosLogWrapper.e("Full sync check failed: No site selected")
+            return WooPosFullSyncRequirement.Error("No site selected")
+        }
+


💡 I'm wondering if we need to check isPeriodicSyncEnabledForSite here as well. Otherwise, this class might require sync while the worker always finishes with failure on line WooPosLocalCatalogSyncWorker::54. Wdyt?

P.S. Feel free to create a separate ticket.

…overdue-handling

samiuelson · 2025-10-20T06:25:13Z

Thanks @samiuelson for iterating on the PR! I've reviewed the code and it all looks good to me. However, I've encountered a couple issues when testing the PR. I'd consider merging it as is and fixing the bugs in a separate PR, wdyt?

Infinite splash screen

Downgrade your site to WooCommerce 10.2 or older

Clean apps data

Login

Enter POS

Notice catalog is syncing -> notice /variations requests fail since the endpoint isn't available in v10.2 => the logs mention Worker result RETRY which isn't properly handled (it goes again into ENQUEUED state on Retry).

Task created: WOOMOB-1536

POS Opened with empty catalog

Clean apps data

Login

Turn off wifi/data

Open POS

Notice expected error

Tap on retry

Turn on wifi/data

Tap on retry

Notice you are allowed to enter POS before the initial sync completes.

Task created: WOOMOB-1537

I appreciate the thorough review, Jirka! I added follow-up tasks in linear: WOOMOB-1538, WOOMOB-1537, WOOMOB-1536.

…due-warning [Woo POS][Local Catalog] Full sync overdue warning banner

samiuelson added 3 commits October 2, 2025 12:03

Allow storing last full sync timestamp

32eaa62

Store full sync timestamp

5aec9de

Check if full sync is overdue

df96e15

samiuelson changed the title ~~Woomob 1412 woo poslocal catalog full sync overdue handling~~ [Woo POS][Local Catalog] Full sync overdue handling Oct 2, 2025

Satisfy detekt's complaints

7dd0994

samiuelson added 2 commits October 2, 2025 18:28

Merge branch 'woomob-1405-woo-poslocal-catalog-run-incremental-sync-o…

170d746

…n-pos-splash' into woomob-1412-woo-poslocal-catalog-full-sync-overdue-handling

Clean up code

925d668

samiuelson added the type: task An internally driven task. label Oct 2, 2025

samiuelson added this to the 23.4 milestone Oct 2, 2025

samiuelson requested a review from kidinov October 2, 2025 16:42

samiuelson marked this pull request as ready for review October 2, 2025 16:43

Clean up code

f6edb88

samiuelson requested review from malinajirka and removed request for kidinov October 3, 2025 07:11

samiuelson added the status: do not merge Dependent on another PR, ready for review but not ready for merge. label Oct 3, 2025

malinajirka modified the milestones: 23.4, 23.5 Oct 3, 2025

Base automatically changed from woomob-1405-woo-poslocal-catalog-run-incremental-sync-on-pos-splash to trunk October 3, 2025 11:05

samiuelson marked this pull request as draft October 3, 2025 11:33

samiuelson removed the request for review from malinajirka October 3, 2025 11:33

samiuelson added 6 commits October 3, 2025 14:25

Add function to check if local catalog is empty

15df113

Add getProductCount method

144d9de

Execute one-time full sync if needed before opening POS

941672f

Remove incremental sync from POS splash

a9eac13

Update WooPosIncrementalSyncReason

06dd9b2

Update WooPosIncrementalSyncReason

2a2bab8

Add tests for WooPosFullSyncStatusCheckerTest

ec3a521

samiuelson marked this pull request as ready for review October 16, 2025 12:56

samiuelson requested a review from Copilot October 16, 2025 13:07

Copilot AI reviewed Oct 16, 2025

View reviewed changes

samiuelson and others added 5 commits October 16, 2025 15:26

Clean up code

fe6375a

Co-authored-by: Copilot <[email protected]>

Clean up code

984b76d

Clean up code

c3a3d32

Rename method

6169c46

Clean up code

33cfa10

samiuelson requested a review from malinajirka October 16, 2025 13:58

wpmobilebot modified the milestones: 23.5, 23.6 Oct 17, 2025

samiuelson added 3 commits October 17, 2025 16:31

Rename val

59358ad

Rename composable

11fac8f

Improve naming of state class and vals

929e1d7

samiuelson marked this pull request as draft October 17, 2025 15:12

samiuelson marked this pull request as ready for review October 17, 2025 15:14

samiuelson added 2 commits October 17, 2025 18:03

Merge branch woomob-1412-woo-poslocal-catalog-full-sync-overdue-handling

ca7b5d6

Update padding

c2db87c

malinajirka approved these changes Oct 18, 2025

View reviewed changes

samiuelson added 2 commits October 20, 2025 07:59

Rename class

56bee46

Merge branch 'trunk' into woomob-1412-woo-poslocal-catalog-full-sync-…

e685840

…overdue-handling

samiuelson removed the status: do not merge Dependent on another PR, ready for review but not ready for merge. label Oct 20, 2025

Merge pull request #14704 from woocommerce/woomob-1412-full-sync-over…

849a70f

…due-warning [Woo POS][Local Catalog] Full sync overdue warning banner

samiuelson enabled auto-merge October 20, 2025 07:00

samiuelson merged commit 2500867 into trunk Oct 20, 2025
16 checks passed

samiuelson deleted the woomob-1412-woo-poslocal-catalog-full-sync-overdue-handling branch October 20, 2025 07:31

[Woo POS][Local Catalog] Catalog full sync required #14678

[Woo POS][Local Catalog] Catalog full sync required #14678

Uh oh!

Conversation

samiuelson commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Steps to reproduce

Testing information

The tests that have been performed

Images/gif

Uh oh!

wpmobilebot commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wpmobilebot commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dangermattic commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

samiuelson commented Oct 16, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wpmobilebot commented Oct 17, 2025

Uh oh!

malinajirka left a comment

Choose a reason for hiding this comment

Infinite splash screen

POS Opened with empty catalog

Uh oh!

Uh oh!

malinajirka Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

malinajirka Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

samiuelson commented Oct 20, 2025

Infinite splash screen

POS Opened with empty catalog

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

samiuelson commented Oct 2, 2025 •

edited

Loading

wpmobilebot commented Oct 2, 2025 •

edited

Loading

wpmobilebot commented Oct 2, 2025 •

edited

Loading

codecov-commenter commented Oct 2, 2025 •

edited

Loading

dangermattic commented Oct 3, 2025 •

edited

Loading